Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: updates tool for ADR management to trestle #316

Merged
merged 4 commits into from
Aug 9, 2024
Merged

docs: updates tool for ADR management to trestle #316

merged 4 commits into from
Aug 9, 2024

Conversation

jpower432
Copy link
Member

@jpower432 jpower432 commented Aug 6, 2024 •
edited
Loading

Description

Keeps the original intent of ADR management and updates solution to use trestle to manage the custom ADR template.

Fixes #314

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How has this been tested?

  • Validated locally

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

@jpower432 jpower432 marked this pull request as ready for review August 6, 2024 21:02
@jpower432 jpower432 requested a review from gvauter August 6, 2024 21:43
gvauter
gvauter approved these changes Aug 7, 2024
View reviewed changes
Copy link
Member

@gvauter gvauter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, one thought on the status field.

@jpower432
Copy link
Member Author

LGTM, one thought on the status field.

@gvauter Not seeing a comment pertaining to the status field.

@gvauter
Copy link
Member

gvauter commented Aug 7, 2024

LGTM, one thought on the status field.

@gvauter Not seeing a comment pertaining to the status field.

@jpower432 Apologies - my comment was around the potential desire for a "proposed" status, similar to what is mentioned here. I believe all the current status values apply after a decision has been made, but do we want a status to represent ADRs that are under review/discussion?

@jpower432
Copy link
Member Author

jpower432 commented Aug 7, 2024 •
edited
Loading

@jpower432 Apologies - my comment was around the potential desire for a "proposed" status, similar to what is mentioned here. I believe all the current status values apply after a decision has been made, but do we want a status to represent ADRs that are under review/discussion?

Good catch. I think an ADR that has been submitted via the PR process could have a proposed status. I will add that to the comment.

@jpower432 jpower432 requested a review from gvauter August 7, 2024 21:31
gvauter
gvauter approved these changes Aug 8, 2024
View reviewed changes
Copy link
Member

@gvauter gvauter left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@jpower432 jpower432 merged commit 9666031 into main Aug 9, 2024
11 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@gvauter gvauter gvauter approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Update ADR to use trestle for markdown validation
2 participants
@jpower432 @gvauter